شروع سریع: API تکمیل‌های چت

پیش‌نیازها و URL پایه

API ما کاملاً با رابط تکمیل‌های چت استاندارد OpenAI سازگار است. برای شروع ارسال درخواست‌ها تنها به یک URL پایه و یک کلید API نیاز دارید. URL پایه HTTPS://api.howmuchisanapikey.com/v1 است. این یک endpoint واحد تمام تولید متن را مدیریت می‌کند و نیازی نیست که چندین URL سرویس یا پیکربندی‌های پروکسی را مدیریت کنید.

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

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

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

شما برای تولید متن پایه نیازی به ارسال هدرهای اضافی ندارید. با این حال، اگر از ویژگی‌های خاصی مانند حالت JSON یا فراخوانی تابع استفاده می‌کنید، باید هدر Content-Type را روی application/json تنظیم کنید. این به سرور می‌گوید که بدنه درخواست شما را چگونه به درستی تجزیه کند.

ارسال اولین تکمیل چت شما

درخواست POST را به /v1/chat/completions ارسال کنید و تاریخچه پیام‌ها و شناسه مدل را وارد کنید. شناسه مدل "uncensored" است. این مدل برای پاسخ‌دهی بدون رد برای محتوای بزرگسالان قانونی، داستان‌ها یا موضوعات بحث‌برانگیز تنظیم شده است. این مدل بر اساس هنجارهای سیاسی یا اجتماعی استاندارد فیلتر نمی‌کند.

در اینجا یک مثال curl پایه برای شروع کار آورده شده است:

Copycurl https://api.howmuchisanapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a simple hello world function in python"}]
  }'

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

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

از رویدادهای ارسالی سرور (SSE) برای دریافت توکن‌ها همان‌طور که تولید می‌شوند استفاده کنید. این تأخیر ادراک‌شده را برای خروجی‌های طولانی کاهش می‌دهد. پارامتر stream را در بدنه‌ی درخواست خود روی true تنظیم کنید. سرور چندین قطعه ارسال خواهد کرد، که هر کدام شامل یک delta جزئی از پاسخ هستند.

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

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

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

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

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

شما محدود به ۳۰۰ درخواست در دقیقه به ازای هر کلید و ۸ درخواست همزمان هستید. اگر از این محدودیت‌ها تجاوز کنید، خطای 429 Too Many Requests دریافت خواهید کرد. بدنه پاسخ شامل جزئیات retry-after خواهد بود. محدودسازی سمت کلاینت را برای جلوگیری از تلاش‌های مجدد غیرضروری تنظیم کنید.

اگر اعتبار پیش‌پرداخت شما تمام شد، API خطای 402 Payment Required را برمی‌گرداند. می‌توانید در هر زمان از طریق ارزهای دیجیتال موجودی خود را شارژ کنید. خطاها و رد شدن درخواست‌ها رایگان هستند، بنابراین شما تنها برای تولید موفق توکن‌ها هزینه می‌پردازید. پنجره متن 100,000 توکن برای مجموع ورودی و خروجی است.

پایتون

Copyfrom openai import OpenAI

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