شروع سریع API Codex

نصب و پیکربندی

The codex api نیاز به یک کلید معتبر و URL پایه صحیح دارد. از طریق Google یا ایمیل ثبت‌نام کنید تا کلید خود را فوراً دریافت کنید. نیازی به شماره تلفن نیست. از SDKهای رسمی OpenAI با تنظیم base_url به https://api.codexfiyat.com/v1.

احراز هویت از Authorization: Bearer هدر. هر حساب کاربری یک کلید فعال دارد. ایجاد کلید جدید، کلید قبلی را بلافاصله لغو می‌کند. این چرخش را بدون مدیریت چندین اعتبار ساده می‌سازد.

مثال درخواست پایه

یک درخواست تکمیل به uncensored مدل را با هر کلاینت HTTP استفاده کنید. نقطه پایانی پارامترهای استاندارد مانند temperature و top_p. کلاینت خود را برای مدیریت کارآمد پاسخ‌های JSON پیکربندی کنید.

• مدل را روی uncensored.
• دستورالعمل سیستم خود را برای زمینه قرار دهید.
• پیام‌های کاربر را در تعریف کنید messages آرایه.

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

استریم Yanitlar

استریمینگ را با تنظیم stream: true در درخواست شما. API رویدادهای ارسالی سرور (SSE) را برای تحویل بلادرنگ توکن برمی‌گرداند. هر قطعه را پردازش کنید تا متن را به صورت افزایشی به کاربران خود نمایش دهید.

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

فراخوانی ابزار (فراخوانی تابع)

توابع را در tools پارامتری برای فعال‌سازی فراخوانی ابزار. مدل فراخوانی‌های تابع را در قالب JSON ساختاریافته بازگردانده و استفاده کنید tool_choice: auto برای تشخیص خودکار.

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

حالت JSON

خروجی ساختاریافته را با تنظیم response_format به {"type": "json_object"}مدل JSON معتبر را در پاسخ تضمین می‌کند. این نیاز به تجزیه با regex یا منطق تلاش مجدد را حذف می‌کند.

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

محدودیت‌ها و محدودیت‌ها

API محدودیت‌های سخت‌گیرانه‌ای را برای تضمین پایداری اعمال می‌کند. می‌توانید ۳۰۰ درخواست در دقیقه در هر کلید ارسال کنید. همزمانی به ۸ درخواست همزمان محدود شده است. پنجره زمینه (context window) حداکثر ۱۰۰,۰۰۰ توکن است.

حداکثر خروجی 16,000 توکن در هر درخواست است. اگر max_tokens تنظیم نشده است، محدودیت به 2,048 کاهش می‌یابد. درخواست‌هایی که از محدودیت اندازه بدنه 8 مگابایت تجاوز کنند، خطا برمی‌گردانند. مصرف خود را از طریق داشبورد مانیتور کنید تا از وقفه‌ها جلوگیری شود.

cURL

Copycurl https://api.codexfiyat.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list available server configurations for ubuntu"}]
  }'

پایتون

Copyfrom openai import OpenAI

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