شروع سریع API Dolphin ia

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

API ما در HTTPS://api.dolphinia.cc/v1 قرار دارد و برای هر درخواست به یک کلید API ساده نیاز دارد. این کلید را بلافاصله پس از ثبت‌نام با گوگل یا ایمیل در داشبورد دریافت می‌کنید و هرگز منقضی نمی‌شود. برخلاف واسط‌هایی که هزینه‌ها را پشت اشتراک‌ها پنهان می‌کنند، ما فقط برای توکن‌هایی که واقعاً مصرف می‌کنید هزینه دریافت می‌کنیم. کلید خود را در متغیرهای محیطی خود امن نگه دارید، زیرا هر کسی که کلید را داشته باشد می‌تواند اعتبار پیش‌پرداخت شما را خرج کند. سرویس محدودیت سخت‌گیرانه‌ای معادل 300 درخواست در دقیقه برای هر کلید را برای حفظ پایداری برای همه کاربران اعمال می‌کند.

ارسال یک درخواست تکمیل چت (Chat Completion Request)

اولین فراخوانی خود را با استفاده از endpoint استاندارد تکمیل چت با شناسه مدل "uncensored" ارسال کنید. این درخواست پرامپت شما را به سرور ما ارسال کرده و یک پاسخ متنی بدون رد شدن‌های معمولی که در مدل‌های دیگر یافت می‌شود، برمی‌گرداند. می‌توانید تا 8MB داده را در یک بدنه درخواست واحد ارسال کنید که برای بیشتر موارد استفاده استاندارد کافی است. اگر از محدودیت نرخ عبور کنید، سرور یک خطای 429 برمی‌گرداند که نشان می‌دهد باید برای مدت کوتاهی مکث کنید. همیشه بررسی کنید که پاسخ شما شامل یک شی پیام معتبر باشد قبل از پردازش بیشتر.

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

با تنظیم پارامتر stream روی true، قابلیت streaming را فعال کنید که توکن‌ها را همان‌طور که تولید می‌شوند از طریق رویدادهای ارسالی سرور تحویل می‌دهد. این رویکرد تأخیر ادراک‌شده را به شدت کاهش می‌دهد، به ویژه هنگام تولید خروجی‌های بلند تا حداکثر 16,000 توکن در هر درخواست. قطعه نهایی در جریان شامل آمار کامل مصرف توکن است که به شما امکان می‌دهد هزینه‌ها را به صورت بلادرسان ردیابی کنید. می‌توانید این رویدادها را در برنامه خود پردازش کنید تا متن را به صورت تدریجی به کاربر نمایش دهید بدون اینکه منتظر پایان کامل تولید باشید.

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

از فراخوانی تابع بومی با ارائه یک آرایه‌ی tools در درخواست خود بهره ببرید که به مدل اجازه می‌دهد داده‌های ساختاریافته برای برنامه‌های شما بازگرداند. همچنین می‌توانید با استفاده از پارامتر response_format، خروجی JSON دقیق را اجبار کنید که برای یکپارچه‌سازی با سیستم‌های downstream که به پایبنی دقیق به طرحواره نیاز دارند، ایده‌آل است. مدل گزینه‌های tool_choice را پشتیبانی می‌کند تا کنترل کنید که آیا مدل باید تابعی را فراخوانی کند یا می‌تواند آزادانه متن تولید کند. از این ویژگی‌ها برای ساخت عامل‌های (agents) مستحکم که با APIها یا پایگاه‌های داده خارجی تعامل دارند، بدون نیاز به تجزیه‌ی متن‌های نامنظم، استفاده کنید.

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

خلاقیت و تصادفی بودن خروجی را با پارامترهای temperature، top_p و seed دقیقاً مانند کلاینت‌های استاندارد OpenAI کنترل کنید. temperature پایین‌تر نتایج قطعیت‌پذیرتری تولید می‌کند، در حالی که مقدار بالاتر پاسخ‌های متنوع‌تر و خلاقانه‌تر را تشویق می‌کند. تنظیم یک seed قابلیت تکرارپذیری را تضمین می‌کند که برای اشکال‌زدایی رفتارهای خاص در کارگاه‌های LLM uncensored شما حیاتی است. همچنین می‌توانید دنباله‌های stop را تعریف کنید تا تولید را در نشانگرهای خاص متوقف کنید و کنترل دقیقی بر مرزهای خروجی داشته باشید.

محدودیت‌ها، خطاها و پنجره زمینه

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

cURL

Copycurl https://api.dolphinia.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the three main benefits of using Redis for caching."}]
  }'

پایتون

Copyfrom openai import OpenAI

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