مستندات API سازگار با Open ai

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

ابتدا کلاینت خود را با URL پایه و کلید API صحیح پیکربندی کنید. سرویس در https://api.compatibleaiopen.com/v1. کلیدی را از طریق داشبورد با استفاده از Google یا ایمیل به دست می‌آورید. کلید هر درخواست به نقطه پایند را احراز هویت می‌کند.

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

درخواست تکمیل چت استاندارد را با استفاده از uncensored شناسه مدل. API ورودی متنی را می‌پذیرد و خروجی متنی برمی‌گرداند. می‌توانید پارامترهایی مانند temperature یا top_p. پنجره زمینه از مجموعاً ۱۰۰,۰۰۰ توکن برای ورودی و خروجی پشتیبانی می‌کند.

Copycurl https://api.compatibleaiopen.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List three benefits of local inference"}]
  }'

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

به‌روزرسانی base_url پارامتر در کلاینت Python OpenAI استفاده کنید. این به شما اجازه می‌دهد از همان کتابخانه‌ای که از قبل می‌شناسید استفاده کنید. شناسه مدل همچنان uncensored. استریم و استفاده از ابزارها دقیقاً همانطور که برای OpenAI مستندسازی شده است کار می‌کنند. نیازی به بازنویسی منطق برنامه خود ندارید.

Copyfrom openai import OpenAI

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

مشتری Node.js را با URL پایه جدید پیکربندی کنید. کلید API خود را از طریق محیط یا مقداردهی اولیه مشتری عبور دهید. نقطه پایانی از تمام پارامترهای استاندارد پشتیبانی می‌کند. خطاها کدهای وضعیت HTTP استاندارد را برمی‌گردانند. می‌توانید این را بلافاصله در توابع Express یا Serverless موجود یکپارچه کنید.

Copyimport OpenAI from "openai";

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

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

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

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)

Limits and Errors

شما به ۳۰۰ درخواست در دقیقه به ازای هر کلید محدود هستید. درخواست‌های همزمان به ۸ به ازای هر کلید محدود شده‌اند. بدنه درخواست نباید از ۸ مگابایت تجاوز کند. خطای 401 نشان‌دهنده کلید نامعتبر است. خطای 402 به این معنی است که اعتباری ندارید. خطای 429 نشان‌دهنده محدودیت نرخ است. اعتبار هرگز منقضی نمی‌شود. خطاها و رد شدن‌ها رایگان هستند.