راهنمای شروع سریع API Dolphin

احراز هویت: توکن‌های Bearer

احراز هویت به یک توکن Bearer متکی است که در Authorization هدر.

کلید خود را از داشبورد دریافت کنید یا از اعتبار آزمایشی استفاده کنید. هر درخواست باید شامل این هدر باشد تا هویت را اثبات کند.

کلید را امن نگه دارید. آن را فقط با سرویس‌های قابل اعتماد به اشتراک بگذارید.

Endpoint /v1/chat/completions

این اندپوینت، ورودی متن را پردازش کرده و خروجی متنی برمی‌گرداند.

درخواست‌ها را به https://api.whatisdolphin.com/v1 با شناسه مدل و پیام‌ها.

از این ساختار برای تعاملات پایه استفاده کنید.

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

استریم اجازه می‌دهد توکن‌ها را از طریق رویدادهای ارسالی سرور (SSE) به صورت بلادرنگ دریافت کنید.

تنظیم stream به true در پیکربندی درخواست خود.

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

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

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

استفاده از حالت JSON برای انطباق دقیق با طرحواره برای داده‌های ساختاریافته.

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

پنجره زمینه و محدودیت‌های توکن

پنجره زمینه (Context Window) در مجموع ۱۰۰,۰۰۰ توکن پشتیبانی می‌کند.

محدودیت‌های خروجی متفاوت: تنظیم max_tokens برای کنترل، در غیر این صورت به 2,048 توکن پیش‌فرض.

طول ورودی را مدیریت کنید تا در محدوده‌ها برای عملکرد بهینه باقی بمانید.

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

محدودیت‌های نرخ اجازه ۳۰۰ درخواست در دقیقه به ازای هر کلید را می‌دهند.

خطاهای 401 را برای کلیدهای نامعتبر و 429 را برای محدودیت‌های نرخ مدیریت کنید.

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

cURL

Copycurl https://api.whatisdolphin.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Define what a dolphin is in two lines."}]
  }'

پایتون

Copyfrom openai import OpenAI

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