مستندات API

شروع سریع: اتصال اولین درخواست شما

ابتدا کلید خود را از داشبورد تولید کنید. URL پایه برای تمام درخواست‌ها HTTPS://api.filterno.cc/v1 است. کلید خود را در هدر Authorization به عنوان یک توکن bearer ارسال کنید. این پیکربندی با هر کلاینت استاندارد سازگار با OpenAI کار می‌کند.

اتصال را بلافاصله با یک درخواست تکمیل ساده تست کنید. اندپوینت فرمت‌های استاندارد چت را می‌پذیرد و متن خام را بدون فیلتر محتوا برمی‌گرداند.

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

نقطه پایانی: POST /v1/chat/completions

پرامپت‌های خود را به POST /v1/chat/completions ارسال کنید. این تنها نقطه پایانی چتی است که پشتیبانی می‌کنیم. شما یک دستورالعمل سیستم و پیام‌های کاربر را در قالب آرایه ارائه می‌دهید.

شناسه مدل "uncensored" است. ورودی متن را پردازش کرده و خروجی متن برمی‌گرداند. انتظار تولید تصویر یا صدا را از اینجا نداشته باشید.

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

نقطه پایانی: GET /v1/models

مدل‌های موجود را با یک درخواست GET به /v1/models تأیید کنید. این نقطه پایدار لیستی از شناسه‌های مدل پشتیبانی شده را برمی‌گرداند. باید "uncensored" را در پاسخ ببینید.

این اندپوینت، معتبر بودن کلید API شما را تأیید می‌کند. همچنین جزئیات مدل را نشان می‌دهد. از آن برای اشکال‌زدایی مشکلات اتصال استفاده کنید.

پاسخ شامل شناسه مدل و نوع شیء است. قیمت‌گذاری یا محدودیت‌ها را فهرست نمی‌کند. برای نرخ‌های توکن، مستندات را بررسی کنید.

پارامترها: دما، Top-P و Tools

تنوع تولید را با temperature و top_p کنترل کنید. temperature توزیع احتمال را تنظیم می‌کند. top_p توکن‌های با احتمال کم را فیلتر می‌کند. این دو با هم تعادلی بین خلاقیت و تمرکز ایجاد می‌کنند.

از فراخوانی تابع برای تعاملات ساختاریافته استفاده کنید. ابزارها را در بدنه درخواست تعریف کنید. مدل می‌تواند این توابع را فراخوانی کند. tool_choice را برای اعمال رفتار خاص ارسال کنید.

توالی‌های توقف را برای پایان زودهنگام تولید تنظیم کنید. از seed برای نتایج قابل‌تکرار استفاده کنید. جریمه‌های حضور و فراوانی تکرار را کاهش می‌دهند. این پارامترها از استانداردهای رایج OpenAI پیروی می‌کنند.

پاسخ‌های استریم (SSE) و مصرف توکن

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

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

ساختار داده SSE را با دقت تجزیه کنید. وقفه‌های شبکه را به‌طور شایسته مدیریت کنید. API یکپارچگی داده را از طریق مرزهای بخش تضمین می‌کند.

محدودیت‌ها، خطاها و حسابرسی توکن

شما ۳۰۰ درخواست در دقیقه به ازای هر کلید دریافت می‌کنید. همزمانی به ۸ درخواست همزمان محدود است. حداکثر اندازه بدنه درخواست ۸ مگابایت است.

پنجره زمینه ۱۰۰,۰۰۰ توکن است. این مقدار شامل متن ورودی و پاسخ می‌شود. حداکثر خروجی ۱۶,۰۰۰ توکن است. max_tokens را تنظیم کنید تا مصرف را محدود نمایید.

خطاها را با بررسی کدهای وضعیت مدیریت کنید. 401 به معنای کلید نامعتبر است. 402 نشان‌دهنده عدم اعتبار است. 429 نشان‌دهنده محدودیت نرخ است. برای 429 با بازگشت نمایی تلاش مجدد کنید.

cURL

Copycurl https://api.filterno.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top five risks in a standard React application."}]
  }'

پایتون

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

جریان‌سازی

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)