مستندات API هرمز: شروع سریع

نصب و راه‌اندازی

API هرمس با هر کلاینتی که فرمت OpenAI را پشتیبانی می‌کند کار می‌کند. شما به یک URL پایه و یک API key نیاز دارید. یک حساب کاربری از طریق Google یا ایمیل در صفحه Get API key ایجاد کنید. سیستم کلید شما را بلافاصله نشان می‌دهد. شماره تلفن لازم نیست. شما $0.50 اعتبار آزمایشی برای هفت روز دریافت می‌کنید. بعداً فقط با ارز دیجیتال شارژ کنید.

• URL پایه: HTTPS://api.apihermes.cc/v1
• هدر Auth: Authorization: Bearer YOUR_API_KEY
• شناسه مدل: uncensored

SDK مورد علاقه خود را نصب کنید و base URL را تنظیم کنید. endpoint پارامترهای استاندارد تکمیل گفتگو را انتظار دارد. کلید خود را امن نگه دارید. یک کلید جایگزین کلید قبلی می‌شود اگر کلید جدیدی تولید کنید.

درخواست تکمیل چت پایه

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

درخواست خود را با یک پیام system و پیام user ساختار دهید. API یک تکمیل برمی‌گرداند. می‌توانید max_tokens را برای کنترل طول خروجی تنظیم کنید. محدودیت خروجی پیش‌فرض 2,048 توکن است. می‌توانید این را به 16,000 توکن به ازای هر درخواست افزایش دهید. استریمینگ از طریق SSE کار می‌کند. فراخوانی تابع موجود است. حالت JSON پشتیبانی می‌شود.

Copycurl https://api.apihermes.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a GET request for the user endpoint"}]
  }'

بدنه درخواست محدود به 8 MB است. محدودیت نرخ 300 درخواست در دقیقه است. همزمانی (Concurrency) هشت درخواست همزمان است. منطق تلاش مجدد (Retry logic) بار اضافی سرور را به‌طور شایسته مدیریت می‌کند.

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

استریم‌دهی توکن‌ها را همان‌طور که تولید می‌شوند ارسال می‌کند. سرور رویدادهای ارسالی سرور (SSE) را ارسال می‌کند. هر قطعه شامل متن ناقص است. قطعه نهایی شامل آمار مصرف توکن است. این رویکرد تأخیر ادراک‌شده را برای پاسخ‌های بلند کاهش می‌دهد. این برای رابط‌های چت ایده‌آل است. شما باید جریان را به درستی مدیریت کنید. قطع‌ها ممکن است رخ دهند. API ترتیب تحویل را فراتر از خود جریان تضمین نمی‌کند.

پارامتر stream را روی true تنظیم کنید. خطوط داده را تجزیه کنید. محتوا را به هم بچسبانید. finish_reason را برای تکمیل بررسی کنید. مدل uncensored با هر SDK سازگار با OpenAI کار می‌کند. کلاینت را پیکربندی کنید تا SSE را مدیریت کند. تعداد توکن‌ها را نظارت کنید. URL پایه یکسان باقی می‌ماند. احراز هویت یکسان است. نیاز به راه‌اندازی اضافی نیست.

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)

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

استفاده از Function Calling و ابزارها

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

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

Copyfrom openai import OpenAI

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

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

حالت JSON و پارامترها

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

پارامترها شامل دما، top_p، stop، seed، presence_penalty و frequency_penalty هستند. دما تصادفی‌سازی را کنترل می‌کند. top_p تنوع را کنترل می‌کند. دنباله‌های توقف تولید را متوقف می‌کنند. Seed قابلیت بازتولید را تضمین می‌کند. جریمه‌های حضور و تکرار، مصرف توکن را تنظیم می‌کنند. این‌ها را برای اصلاح خروجی تنظیم کنید. API از تمام پارامترهای استاندارد پشتیبانی می‌کند. از آن‌ها برای تنظیم پاسخ استفاده کنید. URL پایه یکسان باقی می‌ماند. احراز هویت یکسان است.

Copyimport OpenAI from "openai";

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

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

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

API کدهای وضعیت HTTP استاندارد را برمی‌گرداند. 401 نشان‌دهنده کلید API نامعتبر است. 402 نشان‌دهنده اعتبار پیش‌پرداخت ناکافی است. 429 نشان‌دهنده محدودیت نرخ است. محدودیت 300 درخواست در دقیقه است. هم‌زمانی هشت درخواست در لحظه است. بدنه‌های درخواست به 8 مگابایت محدود شده‌اند. این خطاها را به صورت ایمن مدیریت کنید. با بازگشت نمایی تلاش مجدد کنید. مدل uncensored به محتوای قانونی پاسخ نمی‌دهد. خطاها رایگان هستند. برای درخواست‌های ناموفق هزینه‌ای پرداخت نمی‌کنید. اعتبار پیش‌پرداخت امن است. هرگز منقضی نمی‌شود. برای پرداخت‌های مضاعف به صفحه پشتیبانی مراجعه کنید. فقط ارز دیجیتال. USDT یا USDC. پاداش‌ها اعمال می‌شوند.