مستندات API ونیز برای توسعه‌دهندگان

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

اتصال فوری با تنظیم URL پایه به https://api.veniceapi.com/v1 و شامل کلید API خود در Authorization header. این کلید را بلافاصله پس از ثبت‌نام با گوگل یا ایمیل دریافت می‌کنید. این مدل واحد تمام تولید متن را بدون منطق مسیریابی مدیریت می‌کند. نیازی به مدیریت چندین نقطه پایگاه یا پیکربندی‌های پروکسی ندارید.

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

نقطه پایانی تکمیل چت

درخواست‌های متنی را به /v1/chat/completions اندپوینت با استفاده از روش‌های استاندارد HTTP POST. API یک پیکربندی JSON حاوی نام مدل، دستورات سیستم و پیام‌های کاربر را می‌پذیرد.

در اینجا یک ساختار درخواست پایه آورده شده است:

Copycurl https://api.veniceapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check if the service blocks adult content in the test endpoint"}]
  }'

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

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

یکپارچه‌سازی SDK پایتون

از کتابخانه رسمی پایتون OpenAI برای ارتباط با LLM بدون سانسور استفاده کنید. کلاینت را با آدرس پایه Venice و کلید API خود پیکربندی کنید. این روش ساخت درخواست و تجزیه پاسخ را ساده می‌کند.

Copyfrom openai import OpenAI

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

این روش به طور بی‌نقص با کدهای موجودی که برای OpenAI طراحی شده‌اند کار می‌کند. می‌توانید URL پایه را بدون تغییر قابل توجه در منطق برنامه تغییر دهید. کتابخانه به طور خودکار سریال‌سازی و اتصالات شبکه را مدیریت می‌کند.

به یاد داشته باشید که شناسه مدل باید روی uncensored. این امر تضمین می‌کند که از مدل تنظیم‌شده خاص ارائه‌شده توسط Venice استفاده می‌کنید. مدل‌های دیگر ممکن است الگوهای رفتاری مشابهی نداشته باشند.

یکپارچه‌سازی Node SDK

API را در پروژه‌های JavaScript یا TypeScript با استفاده از SDK Node OpenAI ادغام کنید. Set baseURL به نقطه پایانی Venice و کلید API خود را ارائه دهید. این تنظیم از عملیات همزمان و ناهمزمان پشتیبانی می‌کند.

Copyimport OpenAI from "openai";

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

این یکپارچه‌سازی به شما امکان می‌دهد ربات‌های چت، تولیدکننده‌های محتوا یا ابزارهای استخراج داده را سریعاً بسازید. SDK چرخه حمله درخواست را مدیریت می‌کند، از جمله تلاش مجدد و مدیریت خطا. می‌توانید هدرهای سفارشی را برای موارد استفاده پیشرفته ارسال کنید.

اطمینان حاصل کنید که نسخه صحیح SDK را وارد می‌کنید. نسخه‌های قدیمی‌تر ممکن است از تمام ویژگی‌های موجود در API ونیز پشتیبانی نکنند. برای جزئیات سازگاری، مستندات را بررسی کنید.

پاسخ‌های استریم‌شده از طریق SSE

فعال‌سازی خروجی بلادرنگ با تنظیم stream پارامتر روی true. API یک جریان رویدادهای ارسالی سرور (SSE) را به جای یک شیء JSON کامل برمی‌گرداند. این امکان نمایش توکن‌ها را هنگام تولید فراهم می‌کند.

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)

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

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

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

API محدودیت نرخ ۳۰۰ درخواست در دقیقه در هر کلید را اعمال می‌کند. درخواست‌های همزمان به ۸ درخواست محدود شده‌اند. بدنه درخواست نباید از ۸ مگابایت تجاوز کند. تجاوز از این محدودیت‌ها خطای ۴۲۹ Too Many Requests را برمی‌گرداند.

اندازه پنجره زمینه ۱۰۰,۰۰۰ توکن برای prompt و completion ترکیبی است. حداکثر خروجی در هر درخواست ۱۶,۰۰۰ توکن است. اگر max_tokens تنظیم نشده است، محدودیت پیش‌فرض 2,048 توکن است. ورودی‌های خود را برنامه‌ریزی کنید تا از برش جلوگیری شود.

خطاهای رایج شامل 401 برای کلیدهای نامعتبر و 402 برای اعتبار ناکافی است. این کدها را مدیریت کنید تا کاربران را برای شارژ مجدد درخواست کنید. برای مسائل صورتحساب از صفحه پشتیبانی استفاده کنید. اعتبار هرگز منقضی نمی‌شود، بنابراین می‌توانید بعداً شارژ کنید.