مستندات و شروع سریع API Venice AI

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

شما venice ai api key هر درخواست به API را احراز هویت می‌کند. آدرس پایه (base URL) استاندارد را در پیکربندی SDK خود با مورد بالا جایگزین کنید. سیستم از اعتبار پیش‌پرداخت استفاده می‌کند، بنابراین پیش از ارسال بدنه‌های سنگین، از کافی بودن موجودی خود اطمینان حاصل کنید.

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

متن را به مدل با استفاده از نقطه پایانی استاندارد تکمیل‌های چت ارسال کنید. شناسه مدل همیشه uncensored, که رفتار سازگاری بدون رد محتوای بزرگسالان قانونی را تضمین می‌کند.

کلاینت خود را به URL پایه صحیح تنظیم کنید و شناسه مدل را در بدنه درخواست گنجانید. می‌توانید پارامترهایی مانند temperature یا top_p برای کنترل خلاقیت.

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

استریمینگ و استفاده از SSE

با تنظیم stream: true در درخواست شما. API رویدادهای ارسالی سرور (SSE) را برمی‌گرداند که می‌توانید آن‌ها را تدریجی تجزیه کنید.

هر تکه شامل متن جزئی است، اما معیارهای مصرف توکن تنها در تکه نهایی ظاهر می‌شوند. این رویکرد تأخیر ادراک‌شده را برای کاربران منتظر محتوای طولانی کاهش می‌دهد.

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

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

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

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

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

پارامترها و تنظیمات

رفتار مدل را با پارامترهای استاندارد کنترل کنید. استفاده temperature برای خلاقیت، top_p برای نمونه‌گیری هسته، و stop توالی‌ها برای کوتاه کردن خروجی.

تنظیم seed برای نتایج تکرارپذیر هنگام آزمایش. مقدار presence_penalty و frequency_penalty برای تأثیر بر تنوع موضوعی.

حداکثر خروجی ۱۶,۰۰۰ توکن در هر درخواست است. اگر مشخص نکنید max_tokens, پیش‌فرض ۲,۰۴۸. پرامپت‌های خود را طوری برنامه‌ریزی کنید که در پنجره زمینه ۱۰۰,۰۰۰ توکنی باقی بمانید.

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

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

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

اعتبار شما منقضی نمی‌شود، بنابراین می‌توانید هر زمان که نیاز بود شارژ کنید. برای شارژ از ارز دیجیتال استفاده کنید، اعتبار پاداش برای مبالغ بزرگ‌تر در دسترس است.

cURL

Copycurl https://api.veniceaiapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a summary of the current weather conditions"}]
  }'

پایتون

Copyfrom openai import OpenAI

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