شروع سریع: ادغام در چند دقیقه

۱. SDK خود را نصب کنید

ابتدا کتابخانه رسمی را برای زبان خود نصب کنید. اکثر توسعه‌دهندگان بسته استاندارد را ترجیح می‌دهند زیرا با رابط‌ای که قبلاً می‌شناسند مطابقت دارد. دستور pip install openai برای Python یا npm install openai برای Node.js. شما فقط به یک SDK برای مدیریت تمام درخواست‌ها نیاز دارید.

۲. Base URL خود را تنظیم کنید

کلاینت خود را به نقطه پایانی خاص ما تنظیم کنید. باید URL پایه پیش‌فرض را برای مسیریابی صحیح ترافیک تغییر دهید. از https://api.unsencoredai.com/v1 به‌عنوان آدرس پایه (base URL). کلید API خود را در Authorization header. این پیکربندی با هر کلاینت سازگار با OpenAI کار می‌کند.

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

۳. ارسال اولین درخواست خود

یک درخواست تکمیل چت استاندارد ارسال کنید تا متن تولید شود. شناسه مدل uncensored. می‌توانید پرامپت‌های سیستمی برای هدایت رفتار ارسال کنید. API یک پاسخ متنی مستقیم بازگردانده است. از دستور curl زیر برای آزمایش اتصال بلافاصله استفاده کنید. پاسخ خود را برای choices آرایه.

Copycurl https://api.unsencoredai.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the version number"}]
  }'

۴. مدیریت پاسخ‌های استریم

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

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)

۵. پیکربندی پارامترها

تنظیم temperature, top_p، و stop توالی‌ها. این کنترل‌ها بر خلاقیت و طول خروجی تأثیر می‌گذارند. همچنین می‌توانید از response_format برای حالت JSON. پنجره زمینه از مجموع 100,000 توکن پشتیبانی می‌کند. حداکثر خروجی 16,000 توکن در هر درخواست است. این تنظیمات را برای مورد استفاده خاص خود بهینه‌سازی کنید.

۶. محدودیت‌ها، خطاها و زمینه

خطاها را با استفاده از کدهای وضعیت HTTP استاندارد به شیوه‌ای مناسب مدیریت کنید. خطای ۴۰۱ یعنی کلید API شما نامعتبر است. خطای ۴۰۲ نشان‌دهنده اعتبار پیش‌پرداخت ناکافی است. خطای ۴۲۹ نشان می‌دهد که به حد مجاز ۳۰۰ درخواست در دقیقه رسیده‌اید. پنجره زمینه (context window) شما ۱۰۰,۰۰۰ توکن است. درخواست‌های بیش از ۸ مگابایت ممکن است شکست بخورند. برای اعتبار بازپرداختی صادر نمی‌شود، اما خطاها رایگان هستند.